/*-
 * Copyright (c) 2006, 2007 FTS Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the FTS Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      Util.hpp
 *
 * $FTS$
 */
#ifndef _UTIL_HPP__
#define _UTIL_HPP__ 1

/**
  @file Util.hpp
  @brief Various utilities than helps our life
*/
#include <Types.h>
#include <STLString.hpp>

namespace FTSS // FullTextSearchSystem
{

/**
  @fn DirFilePath
  @brief Create an file path from directory and file
  @param sDir - directory, absolute or relative
  @param sFile - file name
  @return path to file joined with directory name
*/
STLW::string DirFilePath(const STLW::string & sDir, const STLW::string & sFile);

/**
  @brief Normalize value of variable in range [0 .. dRange]
  @param dValue - value to normalize
  @param dRange - range
  @return normalized value
*/
inline W_FLOAT NormalizeFloat(const W_FLOAT & dValue, const W_FLOAT & dRange) { return dValue / dRange; }
// inline W_FLOAT NormalizeFloat(const W_FLOAT & dValue, const W_FLOAT & dRange) { return 2 * dValue / (dValue + dRange); }

/**
  @brief Normalize value of variable in range [0 .. dRange]
  @param dValue - value to normalize
  @param dRange - range
*/
//inline void NormalizeFloat(W_FLOAT & dValue, const W_FLOAT & dRange) { dValue /= dRange; }
//inline void NormalizeFloat(W_FLOAT & dValue, const W_FLOAT & dRange) { dValue = 2 * dValue / (dValue + dRange); }

} // namespace FTSS
#endif // _UTIL_HPP__
// End.
